home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d1 / help.arc / HELP.DOC < prev    next >
Text File  |  1985-08-18  |  6KB  |  131 lines
  1.             Configuring The Help Facility
  2.  
  3.  
  4.     The new SCP help facility can be easily tailored for OEM or 
  5. end user needs. The program "HELP.COM" looks for a file "HELP.SYS" in
  6. the default directory, or through path searching. When distributed, HELP
  7. is located in the BIN directory with the rest of the command files.
  8.  
  9.     HELP.SYS is really just an ASCII text file with a few special
  10. control keys embedded for text manipulation. If you have a screen editor
  11. that can insert control characters (Control-C,etc.) ,such as VEDIT, then
  12. you can re-edit the file for your specific needs, such as special commands,
  13. further explanations. Explained below is how the text file is manipulated.
  14.  
  15.     HELP.COM searches for the file "HELP.SYS" on the default directory.
  16. If it is not found, the default environment will be searched for "PATH="
  17. then it will start path searches, just as the command processor does. If
  18. you have another application which uses the same filename "HELP.SYS" then you
  19. can rename the file,and with the debugger, you can change HELP.COM to search
  20. for another name. See explanation below.
  21.  
  22.     IF HELP finds the file, it opens it with XENIX type file calls. An
  23. 8K buffer is established and the 1st 8k of the file is read in. If there was
  24. no key or subkey typed when help starts up, the default menu is displayed.
  25. When a key is type (such as 'debug') HELP will search each 'record' until
  26. it finds that key. Case is ignored and the length of the key doesn't matter.
  27. You do not have to type the full key name for searching, it will just search
  28. for the 1st match of the key name entered. You need type a key only up to the
  29. first significant letter. For example:
  30.  
  31.         "BAT"    Will find batch processing record.
  32.  
  33.         "BAC"    Will find the backup record.
  34.  
  35.     Records are seperated from each other by a Control-A (01H). If there 
  36. are subkeys for that record, (such as FIND OPTION) the subkey records have a
  37. Control-B at the beggining of the record. Records can be any length, if the 
  38. text buffer fills up, it will automatically fill in more. When the proper
  39. record is found, text is display to the screen, a line counter keeps track
  40. of the number of lines. If the text fills more than 23 lines, the scrolling
  41. stops and waits for user (unless pause flag is disabled). The only non-alpha
  42. characters in the file are Control-D (04H) - page screen, and Control-C - end
  43. of file. A summary of the control keys is below:
  44.  
  45.         Control-A    : Marks beginning of text record.
  46.  
  47.         Control-B    : Marks beginning of sub-key text record.
  48.  
  49.         Control-D    : Page screen (if pause flag). Stop text 
  50.                   writing and fill screen with blanks. Wait
  51.                   for user entry to start. (Cleans up display
  52.                   into desired screen pages)
  53.  
  54.         Control-C    : End of file.
  55.  
  56.     The command line in help is a standard buffer and can use the 
  57. standard DOS editing template keys. If a simple return is typed, the old
  58. template will not be lost. Typing a control-x while records are viewed will
  59. return the user to the help command level. You can return to DOS by typing
  60. control-C at any time, or "Q" or "QUIT" from the help command level.
  61.  
  62.     To speed up search of keys and simplify code, it is assumed that the
  63. keys are in alphanumeric order. If they are not, it will not find the key on
  64. the first pass and an error will be generated. It will find the key on the
  65. 2nd pass, but this is usually not a desired effect. If you add new records,
  66. make sure they are in alphabetical order. 
  67.  
  68.  
  69.     Changing HELP.SYS to another name: Just rename the file with REN.
  70.  
  71.         REN HELP.SYS  (Newname)
  72.  
  73.         You must modify HELP.COM to search for another name. The
  74.         debugger DEBUG.COM can do it. Type the following:
  75.  
  76.         DEBUG \BIN\HELP.COM
  77.  
  78.         This will load in the help command file. Then type
  79.  
  80.         D742
  81.  
  82.         You should see:
  83.  
  84. d742
  85. 0B7E:0740              48 45 4C 50-2E 53 59 53 00 00 00 00       HELP.SYS....
  86. 0B7E:0750  00 24 00 00 00 00 00 00-00 00 00 00 00 00 00 00   .$..............
  87. 0B7E:0760  00 00 00 00 00 00 00 00-00 00 00 00 00 00 00 00   ................
  88.  
  89.         If you don't see the above, search any memory area nearby.
  90.         You must only modify if you find "HELP.SYS". This is a
  91.         reserved area for the filename. You can modify it by typing
  92.  
  93.         E742    "(Newfilename)",0
  94.  
  95.         E is the enter command, and 704 is the starting address for
  96.         the text string. The new filename must be a maximum of 8
  97.         characters for the filename and 3 for the extension. You must
  98.         put a 0 at the end of the name.
  99.  
  100.         Save your new HELP.COM by typing
  101.  
  102.         W
  103.         Q
  104.  
  105.         Do not attempt to modify any registers or other memory
  106.         locations as the program will not work then. All error
  107.         messages will use the new filename you have just set up.
  108.  
  109.  
  110.  
  111.     NEW DOCUMENTATIN
  112.  
  113.  
  114.  
  115.     This program was originally written by me for Seattle Computer
  116. products. Some of the documentation in the help.sys will not apply to
  117. the IBM owners! I hope to download most of these programs (Count,Debug
  118. etc.) to the database in the near future as I know they will be useful
  119. to all PC lovers! Most of these programs were set up for generic
  120. MS-DOS machines and will be unfamiliar to the IBM world. Some of the programs
  121. were also distributed by IBM but I modified them at SCP for our own
  122. needs, since I had the source code to MS-DOS and its utilities.
  123.  
  124.     I hope to xmit most of these different programs sometime soon as
  125. I feel the whole community of users can use them, and since I no longer
  126. work at SCP I have complete rights to them! Enjoy it!
  127.  
  128.  
  129.                     Craig Derouen
  130.                     Seattle,Wa
  131.